/*
 * Copyright (c) 2006-2007 Shane Mc Cormack
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 *
 * SVN: $Id$
 */

package uk.org.dataforce.jisg;

/**
 * This class gives information about a line.
 */
public class LineInfo {
	/** The line type for this line */
	final LineType myLineType;
	
	/** The line this object represents */
	final String myLine;
	
	/**
	 * The additional params related to this line.
	 * What these params actually represent is determined by the LineType
	 */
	final Object[] myParams;
	
	/**
	 * Create a new LineInfo
	 *
	 * @param lineType The Type of line this is
	 * @param line The line that this is
	 * @param params The parameters that go with this line
	 */
	public LineInfo(final LineType lineType, final String line, final Object... params) {
		myLineType = lineType;
		myLine = line;
		myParams = params;
	}
	
	/**
	 * Get the lineType that this class represents
	 *
	 * @return LineType for this line
	 */
	public LineType getLineType() { return myLineType; }
	
	/**
	 * Get the lineType that this class represents
	 *
	 * @return The line
	 */
	public String getLine() { return myLine; }
	
	/**
	 * Get the parameters for this line.
	 *
	 * @return Paramenters for this line
	 */
	public Object[] getParams() { return myParams.clone(); }

	/**
	 * Get a string representation of this Lineinfo
	 *
	 * @return String representation of this Lineinfo
	 */
	public String toString() { return "["+myLineType+"] "+myLine; }
}
